/**
 *    Copyright (C) 2019-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include "mongo/base/status.h"
#include "mongo/db/validate/validate_options.h"
#include "mongo/util/modules.h"

MONGO_MOD_PUBLIC;

namespace mongo {

class NamespaceString;
class OperationContext;
class Collection;
class CollectionPtr;
class BSONObjBuilder;
class Status;
class ValidateResults;

namespace CollectionValidation {

/**
 * Checks if 'hashPrefixes' contains valid hash strings. Throws if any is invalid.
 * When 'equalLength' is true, also checks all hash strings have the same length.
 */
MONGO_MOD_FILE_PRIVATE void validateHashes(const std::vector<std::string>& hashPrefixes,
                                           bool equalLength);

/**
 * Parses and checks the command object and returns a 'ValidationOptions' object used for collection
 * validation.
 */
ValidationOptions parseValidateOptions(OperationContext* opCtx,
                                       NamespaceString nss,
                                       const BSONObj& cmdObj);

/**
 * Expects the caller to hold no locks.
 *
 * @return OK if the validate run successfully
 *         OK will be returned even if corruption is found
 *         details will be in 'results'.
 */
Status validate(OperationContext* opCtx,
                const NamespaceString& nss,
                ValidationOptions options,
                ValidateResults* results);

/**
 * Checks whether a failpoint has been hit in the above validate() code..
 */
MONGO_MOD_FILE_PRIVATE bool getIsValidationPausedForTest();

}  // namespace CollectionValidation
}  // namespace mongo
